2.5 Incluir dependente

Request

Request

mutation AddDependent {
  addDependent(data: { name: "teste", companyId: 10, financialOwnerIds: 68 }) {
    id
    name
  }
}

Params

Parâmetro	Tipo	Descrição
data	AddDependentDataInput!	Dados de inclusão de dependente

Objeto AddDependentDataInput

Campo	Tipo	Descrição
academicClassId	Int	Id da turma à qual o dependente está associado.
city	String	Cidade do endereço do dependente.
companyId	Int	Id da empresa associada ao dependente.
complement	String	Complemento do endereço (apartamento, bloco, etc.).
country	String	País do endereço do dependente.
cpf	String	Número do CPF do dependente.
customFields	[KeyValuePairOfStringAndStringInput!]	Lista de campos customizáveis, cada um consistindo de um par chave-valor (string).
district	String	Bairro do endereço do dependente.
email	String	Endereço de email do dependente.
financialOwnerIds	[Int!]	Lista de IDs dos responsáveis financeiros associados ao dependente.
financialOwnerRefIds	[String!]	Lista de IDs de referência dos responsáveis financeiros associados ao dependente.
id	Int	Id único do dependente.
name	String!	Nome completo do dependente.
number	String	Número do endereço do dependente.
state	String	Estado do endereço do dependente.
street	String	Logradouro do endereço do dependente (rua, avenida, etc.).
zipCode	String	CEP do endereço do dependente.

Response

Response

{
  "data": {
    "addDependent": {
      "id": "effaf373-058b-47f3-bdfe-935466103b06",
      "name": "teste"
    }
  }
}

Result

Campo	Tipo	Descrição
addDependent	AddDependentResult!	Dados de retorno da inclusão de dependente

Objeto AddDependentResult

Campo	Tipo	Descrição
id	UUID!	Identificador único universal do dependente.
name	String!	Nome completo do dependente.

Inclusão de dependente com matrícula e turma

Atenção

É possível adicionar uma matrícula e uma turma para o dependente no momento da inclusão, desde que seja com uma matrícula ainda não cadastrada na escola e uma turma devidamente registrada.

mutation AddDependent {
  addDependent(
    data: {
      name: "teste 2"
      companyId: 10
      financialOwnerIds: 68
      academicClassId: 1
      customFields: [{ key: "ENROLLMENT", value: "ONE_0001" }]
    }
  ) {
    id
    name
  }
}